Skip to content

docs: technical integrity audit and alignment with v0.4.0-rc4#18

Merged
PythonWoods-Dev merged 1 commit intomainfrom
fix/docs-technical-integrity
Apr 1, 2026
Merged

docs: technical integrity audit and alignment with v0.4.0-rc4#18
PythonWoods-Dev merged 1 commit intomainfrom
fix/docs-technical-integrity

Conversation

@PythonWoods-Dev
Copy link
Copy Markdown
Contributor

Summary

This PR performs a critical technical audit of the documentation to ensure alignment with the actual codebase and pyproject.toml logic for v0.4.0-rc4.

Key Technical Corrections

  • Extras De-mystification: Removed the incorrect claim that zenzic[docs] is required for MkDocs validation. Clarified that Zenzic's MkDocsAdapter is dependency-free and uses a permissive YAML loader to ignore unknown tags natively.
  • Installation vs. Execution: Refined the distinction between uvx (ephemeral/CI execution) and uv add --dev (development dependency).
  • Static Analysis Limits: Added a new "Static Analysis Limits" section to guide/engines.md. This honestly documents how Zenzic handles !ENV tags (as null), dynamic navigation plugins (ignored), and macros (not evaluated), providing the excluded_dirs workaround.
  • Flag Accuracy: Updated the --strict flag description to include its role in triggering external URL validation in addition to treating warnings as errors.
  • i18n Parity: All technical corrections have been mirrored in the Italian documentation (docs/it/).

Impact

This update moves Zenzic away from "marketing-driven" documentation toward "engineering-driven" transparency, reducing user friction and preventing unnecessary dependency bloat in user environments.

@PythonWoods-Dev PythonWoods-Dev merged commit 972793f into main Apr 1, 2026
9 checks passed
@PythonWoods-Dev PythonWoods-Dev deleted the fix/docs-technical-integrity branch April 1, 2026 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant